Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor Updates to Reflect Common Changes in Downstream Projects #47

Merged
merged 8 commits into from
Jun 2, 2021
Merged

Minor Updates to Reflect Common Changes in Downstream Projects #47

merged 8 commits into from
Jun 2, 2021

Conversation

mcdonnnj
Copy link
Member

@mcdonnnj mcdonnnj commented May 24, 2021 •
edited by jsf9k
Loading

🗣 Description

This PR primarily includes some changes that are commonly made downstream. It also includes the full terraform-docs that is typically used in our projects now in both the module README and the examples README.

💭 Motivation and context

I see some of these edits in every new descendant project and thought they should just be made in the upstream skeleton.

🧪 Testing

Automated tests pass and there's no real functionality changes being made.

✅ Checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All new and existing tests pass.

mcdonnnj added 7 commits May 24, 2021 15:08
@mcdonnnj
Add periods to module variable descriptions
5b2afc2
@mcdonnnj
Add periods to module output descriptions
ce3d073
@mcdonnnj
Add periods to example output descriptions
e0b3689
@mcdonnnj
Fix the order of example outputs
d1bff80
@mcdonnnj
Add period to example variable description
7337db4
@mcdonnnj
Update the README
5a6d66a 
Include the changes made here as well as match all the information we typically
include now.
@mcdonnnj
Update the example README
5d065a5 
Include the changes made here as well as match all the information we typically
include now.
@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels May 24, 2021
@mcdonnnj mcdonnnj self-assigned this May 24, 2021
jsf9k
jsf9k requested changes May 24, 2021
View reviewed changes
Copy link
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have one issue that I'd like to resolve among @cisagov/team-ois before merging this pull request.

providers.tf Outdated Show resolved Hide resolved
@mcdonnnj mcdonnnj force-pushed the improvement/minor_updates branch from 8d031e9 to 5d065a5 Compare June 1, 2021 17:17
@mcdonnnj mcdonnnj requested a review from jsf9k June 1, 2021 17:19
dav3r
dav3r approved these changes Jun 1, 2021
View reviewed changes
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🦄

@mcdonnnj mcdonnnj merged commit 2906811 into develop Jun 2, 2021
@mcdonnnj mcdonnnj deleted the improvement/minor_updates branch June 2, 2021 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dav3r dav3r dav3r approved these changes

@jsf9k jsf9k jsf9k approved these changes

@felddy felddy Awaiting requested review from felddy felddy is a code owner

@hillaryj hillaryj Awaiting requested review from hillaryj

Assignees

@mcdonnnj mcdonnnj

Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
Skeleton Maintenance
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mcdonnnj @jsf9k @dav3r